home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / iconmanager / whatis / whatis.doc < prev    next >
Text File  |  1996-04-07  |  3KB  |  181 lines
  1. whatis.library/CmpFileType                            whatis.library/CmpFileType
  2.  
  3.    NAME
  4.     CmpFileType -- compares two FileTypes.
  5.  
  6.    SYNOPSIS
  7.     result = CmpFileType( FileType1, FileType2 )
  8.     D0              A0     A1
  9.  
  10.     WORD CmpFileType( FileType Type1, FileType Type2 );
  11.  
  12.    FUNCTION
  13.     Compares the two supplied FileTypes. Returns zero if Type1 == Type2.
  14.     
  15.    INPUTS
  16.     Type1 = FileType
  17.     Type2 = FileType
  18.  
  19.    RESULT
  20.     result - zero if Type1 == Type2
  21.          >zero if Type1 > Type2
  22.          <zero if Type1 < Type2
  23.  
  24.    NOTES
  25.  
  26.    BUGS
  27.  
  28.    SEE ALSO
  29.  
  30.  
  31. whatis.library/GetIconName                            whatis.library/GetIconName
  32.  
  33.    NAME
  34.     GetIconName -- get default icon filename
  35.  
  36.    SYNOPSIS
  37.     IconName = GetIconName( FileType )
  38.     D0            A0
  39.  
  40.     char *GetIconName( FileType );
  41.  
  42.    FUNCTION
  43.     Returns a pointer to the filename of the default icon for the
  44.     specified FileType.
  45.  
  46.    INPUTS
  47.     FileType = ULONG returned by WhatIs().
  48.  
  49.    RESULT
  50.     IconName - pointer to a NULL-terminated string.
  51.  
  52.    NOTES
  53.  
  54.    BUGS
  55.  
  56.    SEE ALSO
  57.  
  58.  
  59. whatis.library/GetIDString                            whatis.library/GetIDString
  60.  
  61.    NAME
  62.     GetIDString -- converts FileType into a string for displaying
  63.  
  64.    SYNOPSIS
  65.     Type = GetIDString( FileType )
  66.     D0            A0
  67.  
  68.     char *GetIDString( FileType );
  69.  
  70.    FUNCTION
  71.     Returns a pointer to a C-format string which describes the FileType
  72.     supplied.
  73.  
  74.    INPUTS
  75.     FileType = ULONG returned by WhatIs().
  76.  
  77.    RESULT
  78.     Type - pointer to a string of characters.
  79.  
  80.    NOTES
  81.  
  82.    BUGS
  83.  
  84.    SEE ALSO
  85.  
  86.  
  87. whatis.library/GetIDStringMaxLen                whatis.library/GetIDStringMaxLen
  88.  
  89.    NAME
  90.     GetIDStringMaxLen -- returns the length of the longest IDString in 
  91.                 the table.
  92.  
  93.    SYNOPSIS
  94.     length = GetIDStringMaxLen()
  95.     D0
  96.  
  97.     ULONG GetIDStringMaxLen( void );
  98.  
  99.    FUNCTION
  100.     
  101.    INPUTS
  102.  
  103.    RESULT
  104.  
  105.    NOTES
  106.  
  107.    BUGS
  108.  
  109.    SEE ALSO
  110.  
  111.  
  112. whatis.library/GetIDType                                whatis.library/GetIDType
  113.  
  114.    NAME
  115.     GetIDType -- returns the FileType of the given string.
  116.  
  117.    SYNOPSIS
  118.     FileType = GetIDType( Type )
  119.     D0              A0
  120.  
  121.     ULONG GetIDType( char * );
  122.  
  123.    FUNCTION
  124.     Converts the Type string (as returned by GetIDString) into a
  125.     FileType.
  126.  
  127.    INPUTS
  128.     Type = pointer to a string of characters.
  129.  
  130.    RESULT
  131.     FileType - private value. See WhatIs(). If not found, returns
  132.     TYPE_UNKNOWNIDSTRING.
  133.  
  134.    NOTES
  135.  
  136.    BUGS
  137.  
  138.    SEE ALSO
  139.  
  140.  
  141. whatis.library/WhatIs                                      whatis.library/WhatIs
  142.  
  143.    NAME
  144.     WhatIs -- identify a file
  145.  
  146.    SYNOPSIS
  147.     FileType = WhatIs( Name, TagItem )
  148.     D0           A0     A1
  149.  
  150.     ULONG WhatIs( char *, struct TagItem * );
  151.  
  152.    FUNCTION
  153.     Attempts to identify the file specified by Name.
  154.  
  155.    TAGS
  156.     WI_FIB - ti_data points to a FileInfoBlock.
  157.     WI_Deep - Set to TRUE to deepsearch the file. Defaults to FALSE.
  158.     WI_Buffer - ti_data points to a NULL-terminated buffer.
  159.     WI_BufLen - ti_data is the length of the buffer.
  160.     WI_DLX - ti_data is DLX_numble, see arp.library.
  161.     WI_DLT - ti_data is DLT_numble, see dos.library.
  162.  
  163.    INPUTS
  164.     Name = pointer to NULL-terminated string
  165.     TagItem = pointer to TagItem array, with tag values as described
  166.     above.
  167.  
  168.    RESULT
  169.     FileType - Private value. Pass to other functions for more
  170.     information.
  171.     If NULL, the file wasn't scanned. Possible return values are:
  172.     TYPE_UNSCANNED, TYPE_UNKNOWNFILETYPE
  173.    NOTES
  174.  
  175.    BUGS
  176.  
  177.    SEE ALSO
  178.  
  179.  
  180.  
  181.